closeBackground

Type

message

Summary

Sent to the current card when the user is leaving a card that has a group to go to one that doesn't have the group.

Syntax

closeBackground <pBackgroundID>

Description

Handle the closeBackground message if you want to perform cleanup or do other tasks when the user leaves a background.

A background is closed when the user either goes to a card that doesn't have the group on it, or closes the stack.

The closeBackground message is sent only if the group's backgroundBehavior property is set to true. If the group's backgroundBehavior is false, no closeBackground message is sent, even if the group is placed on multiple cards.

A separate closeBackground message is sent for each background that is being closed.

Parameters

Name	Type	Description
pBackgroundID		The ID number of the background being exited.

Examples

on closeBackground theClosedGroupID
-- save when exiting a particular background:
  if theClosedGroupID is 234 then saveNotesToFile
  pass closeBackground
end closeBackground

Related

glossary: property, current card, message, background, group

keyword: card

message: preOpenBackground, closeStack, shutdown, openBackground, closeCard, closeBackground

object: card

property: backgroundBehavior

command: group

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile